home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / utils / pagin605.zip / PAGINATE.TXT < prev    next >
Text File  |  1996-05-09  |  68KB  |  1,742 lines
  1. # % PAGINATE.TXT -- documentation for the PAGINATE command
  2. # % Please reformat using "PAGINATE PAGINATE.TXT PAGINATE.DOC /OVERWRITE /-I"
  3. # % (There's a batch file--PAGDOCS.BAT--that does this for you)
  4. # page=60
  5. # adjust
  6. # TITLE CENTER WIDTH=80
  7. ^O%12%                         ^B%3%                       Revised: ^A
  8.  
  9. # end
  10. # justify width 80
  11. # index "Column headers" "(See also HEADER)" DUMMY
  12. # index "END" "(See FOOTER)" DUMMY
  13. # index "END" "(See HEADER)" DUMMY
  14. # index "END" "(See MULTICOLUMN)" DUMMY
  15. # index "END" "(See TITLE)" DUMMY
  16. # index "END" "(See UNIT)" DUMMY
  17. # index "Error messages" "(See also /DEBUG parameter)" DUMMY
  18. # index "Environmental variable" "(See SET PAGINATE)" DUMMY
  19. # index "Formatting commands" "LENGTH" "(See WIDTH command)" DUMMY
  20. # index "PAGINATE.INI" "(See INI File)" DUMMY
  21. # index "PAGNOASC.INI" "(See Character-translation Table)" DUMMY
  22. # index "Printer" "(See RESET=string)" DUMMY
  23. # index "Printer" "(See SETUP=string)" DUMMY
  24. # index "INDEX" "(See INCLUDE INDEX)" DUMMY
  25. # index "Length" "Of line" "(See WIDTH command)" DUMMY
  26. # index "Length" "Of page" "(See PAGE command)" DUMMY
  27. # index "LENGTH" "(See WIDTH command)" DUMMY
  28. # index "Lines" "Across page" "(See RULE command)" DUMMY
  29. # index "Missing data values" "(See INMISS=val)" DUMMY
  30. # index "Missing data values" "(See INMISSC=val)" DUMMY
  31. # index "Missing data values" "(See OUTMISS=val)" DUMMY
  32. # index "Missing data values" "(See OUTMISSC=val)" DUMMY
  33. # index "Sorting" "Case-insensitive" "(See SORTI=varspec)" DUMMY
  34. # index "Sorting" "Descending" "(See SORTD=varspec)" DUMMY
  35. # index "SPACING=1" "(See also SINGLE)" DUMMY
  36. # index "SPACING=2" "(See also DOUBLE)" DUMMY
  37. # index "SPACING=3" "(See also TRIPLE)" DUMMY
  38. # index "Widow lines" "(See ADJUST)" DUMMY
  39. # index "Overview"
  40. The PAGINATE.EXE program formats text files containing embedded "marker"
  41. commands.  Specifically, the program can be used to:
  42. # unit
  43. # indent 4-2
  44.   * Align, justify, center text
  45.   * Add headers and footers to pages
  46.   * Add page breaks
  47.   * Control indentation
  48.   * Control spacing
  49.   * Sort the file (alphabetically, not numerically all that well) in either
  50. ascending or descending order.
  51.   * Generate indexes
  52.   * Select fields to print
  53.   * Print out dBase and ASCII-delimited files in tabular forms
  54.   * Bring ASCII-delimited and dBase files into existing text
  55.   * Translate characters
  56. # end
  57.  
  58. # index "National Institutes of Health"
  59. The PAGINATE.EXE program is based on a document-formatting language that exists
  60. on the mainframe computers at the National Institutes of Health in Bethesda, MD.
  61. The text editor used there is called WYLBUR and it does all sorts of wonderful
  62. things like creating programs.
  63.  
  64. For documentation, you use the WYLBUR text editor and insert document formatting
  65. codes.  These codes determine things like margins, indentation, justification,
  66. spacing, etc.  After you embed all of these formatting commands, you issue a
  67. PAGINATE command and everything's reformatted for you.
  68.  
  69. PAGINATE includes many of the WYLBUR pagination commands and then adds a number
  70. or database operations.
  71.  
  72. Typically, I do most of my text formatting using the PE2 text editor which
  73. I dearly love.  The main drags about using PE2 for text formatting are that:
  74. # unit
  75. # indent 4-2
  76.   * It doesn't do titles and footers
  77.   * It adds a space after every period followed by a space so "12 p.m. at the
  78. store" comes out as "12 p.m.  at the store"
  79.   * It doesn't handle the database functions (multicolumn printing, dBase,
  80. ASCII-delimited, and sorting) that are useful to have.
  81.   * It isn't sold anymore and I always hated PE3 after becoming an unwitting
  82. beta tester for them.  (Sorry guys but the free pen you gave me just didn't make up for the
  83. fact that it still didn't work right and I don't like paying to become a beta
  84. tester.)
  85. # end
  86.  
  87. # % Nope.  Can't generate a table of contents yet using PAGINATE.
  88. # % Maybe someday!
  89. # unit verbatim
  90. # indent 8
  91. Quick remaining contents:
  92.   Introduction to marker commands...................... pg  2
  93.   Sample files......................................... pg  4
  94.   Command reference:
  95.     Formatting commands................................ pg  4
  96.     Database-related functions......................... pg 10
  97.   Control codes........................................ pg 17
  98.   Varspecs............................................. pg 18
  99.   Field-definition file................................ pg 19
  100.   Specifying parameters................................ pg 20
  101.   Character-translation file........................... pg 20
  102.   Examples............................................. pg 22
  103.   Syntax............................................... pg 23
  104.   Author............................................... pg 25
  105.   Index................................................ pg 26
  106. # end
  107. #
  108. # index "Marker commands"
  109. Introduction to marker commands:
  110.  
  111. PAGINATE typically expects document formatting codes to be embedded in the text
  112. document itself.  If you want the same formating to be used through the entire
  113. document, however, you can pass in most of the arguments (see the "Syntax"
  114. discussion below) or use a separate control file instead.
  115.  
  116. The formatting codes are preceded by a "marker" character.  This is a character
  117. which begins in column 1 of the text (or control) file and is typically the
  118. character "#".  (When passing in the formatting codes, all codes are preceded by
  119. a "/".)
  120.  
  121. For example, you might have text like this:
  122.  
  123. # unit
  124. # verbatim
  125.         #align width 20
  126.         This is some sample text which you have asked to align.  The margins
  127.         will be placed at 1 and 20.  You can use an indent command to shift
  128.         the left margin if desired.
  129. # end
  130.  
  131.  
  132. This example shows one marker statement ("#align width 20") which contains two
  133. formatting commands:  "align" and "width 20".  Formatting commands are keyword
  134. specific.
  135.  
  136. You can put in commands on the same line which have no logical bearing to one
  137. another like "#align spacing=2".  Exceptions:
  138.  
  139.    * Do not do this for INCLUDE statements
  140.    * Do not do this for INDEX statement
  141.  
  142. # index "Semi-colons"
  143. Formatting commands can be separated by semi-colons for clarity but only a space
  144. is required.  The case of the marker statement is irrelevant.
  145.  
  146. After the PAGINATE command is run, the above text will come out like this:
  147.  
  148. # unit
  149. # verbatim
  150.         This is some sample
  151.         text which you have
  152.         asked to align.  The
  153.         margins will be
  154.         placed at 1 and 20.
  155.         You can use an
  156.         indent command to
  157.         shift the left
  158.         margin if desired.
  159. # end
  160.  
  161. #
  162. # index "Paragraphs"
  163. In terms of alignment, justification, variable indentation, etc, the system
  164. treats each paragraph as a separate entity.  A paragraph is defined as beginning
  165. with a blank line or a space.  For example:
  166.  
  167. # unit
  168. # verbatim
  169.         #justify width 25
  170.         This is one paragraph
  171.  
  172.         And this is another paragraph.
  173.         But this is the same paragraph.
  174.           New paragraph here.
  175. # end
  176.  
  177. Comes out as this:
  178.  
  179. # unit
  180. # verbatim
  181.         This is one paragraph
  182.  
  183.         And   this   is   another
  184.         paragraph.  But  this  is
  185.         the same paragraph.
  186.           New paragraph here.
  187. # end
  188.  
  189. # index "Range of formatting"
  190. Formatting commands cover a variety of functions.  Note that formatting within
  191. titles, footers, headers, and UNIT...END blocks does not affect formatting
  192. beyond the END statement.  For example, the width of the title below does not
  193. affect the width outside the title:
  194.  
  195. # unit
  196. # verbatim
  197.         # align width 50
  198.         This text is aligned width 50.  Here comes a title.
  199.         # title center width 70
  200.         This title is centered within width 70.
  201.  
  202.         # end
  203.         This text (outside the TITLE ... END block) is still being
  204.         aligned (not centered) to width 50 (not 70).
  205. # end
  206.  
  207. # index "Short lines"
  208. # index "Paragraphs" "One liners"
  209. Note that JUSTIFY and ALIGN do not affect lines which are on their own and do
  210. not continue to a second line and do not exceed the given page length.
  211.  
  212. As an example, note that the file names shown in the next section ("Sample
  213. files:") are not affected even though they are actually controlled by a JUSTIFY
  214. marker command.  This may seem like an error at times especially if you've
  215. already indented text; remember that indentation is the system's clue that there
  216. is a new paragraph so pre-indented text won't be affected much by the program.
  217.  
  218. This feature is, by the way, frequently useful in defining oddly formatted
  219. sections of text without needing to use a "# UNIT VERBATIM" statement around it;
  220. just make sure each line begins with at least one space and the program won't
  221. touch it.
  222.  
  223. #
  224. # index "Sample files"
  225. Sample files:
  226.  
  227. An example input file and its related components are included in this ZIP
  228. under PAGDEMO.*.  You can modify this and see how features are affected.  The
  229. demonstration files are as follows:
  230.  
  231. # % As is documented above, the following lines don't need a VERBATIM
  232. # % marker because they are short enough to not be affected by the JUSTIFY
  233. # % marker command.
  234.         PAGDEMO.BAT      Batch file that actually runs the demo file
  235.         PAGDEMO.#1       The primary file for the demo
  236.         PAGDEMO.#1D      The ASCII-delimited file brought in for the demo
  237.         PAGDEMO.#1C      The field-definition file used for the demo
  238.  
  239.  
  240. # rule=-
  241.                                COMMAND REFERENCE
  242. # rule=-
  243. # index "Formatting commands"
  244.                               Formatting commands
  245.  
  246.  
  247. # index "Equal signs"
  248. The following section describes the formatting commands alphabetically with some
  249. cross-referencing.  The commands are case insensitive ("align" and "ALIGN" are
  250. the same).  Typically, the equal signs are optional ("WIDTH=80" is the same as
  251. "WIDTH 80") except when used from the DOS command line.  Remember, the text
  252. line that these commands appear in must begin with the designated marker
  253. character (typically a "#").
  254.  
  255. # index "Formatting commands" "Default values"
  256. Default initial values (format commands):
  257.         FLAG=NULL
  258.         INDENT=0
  259.         INDENTER=NULL
  260.         WIDTH=80
  261.         MARKER=#
  262.         PAGE=60
  263.         PAGEEJECT=\012\013\010
  264.         SINGLE
  265.         VERBATIM
  266.  
  267. # indent 3-3
  268. # index "Formatting commands" "% (comments)"
  269. # index "% (comments)"
  270. %: Comments.  You can add comments after any marker command or you can embed
  271. them as marker commands all on their own.
  272.  
  273. # index "Formatting commands" "ADJUST"
  274. # index "ADJUST"
  275. ADJUST:  Tells the system to not write single lines on the bottom of a page.
  276. This is typically done to control "widow lines", cases where the first line of
  277. a paragraph prints on the bottom of one page and the remainder of the paragraph
  278. prints on the top of the next.
  279.  
  280. # index "Formatting commands" "-ADJUST"
  281. # index "-ADJUST"
  282. -ADJUST:  Says that "widow lines" are okay.
  283.  
  284. # index "Formatting commands" "ALIGN"
  285. # index "ALIGN"
  286. ALIGN:  Aligns text (uneven right margins) according to the default page width.
  287. See also: CENTER, JUSTIFY, RIGHT, and VERBATIM.
  288.  
  289. # index "Formatting commands" "-ALIGN"
  290. # index "-ALIGN"
  291. -ALIGN:  Same thing as VERBATIM.
  292.  
  293. # index "Formatting commands" "CENTER"
  294. # index "CENTER"
  295. CENTER:  Centers text according to the default page width.  Unlike ALIGN,
  296. JUSTIFY, and RIGHT, the CENTER command does not actually reflow any text.  If
  297. your line is wider than the specified width, it will not be split into multiple
  298. lines for you.  Note when CENTER is in effect, leading spaces are automatically
  299. removed from text lines so centering can be recalculated correctly.  See also:
  300. ALIGN, JUSTIFY, RIGHT, VERBATIM, and WIDTH.
  301.  
  302. # index "Formatting commands" "-CENTER"
  303. # index "-CENTER"
  304. -CENTER:  Same thing as VERBATIM.
  305.  
  306. # index "Formatting commands" "DOUBLE"
  307. # index "DOUBLE"
  308. DOUBLE:  Double-spaces all text.  See also: SINGLE, SPACING=n, and TRIPLE.
  309.  
  310. # index "Formatting commands" "EJECT"
  311. # index "EJECT"
  312. # index "Page-eject characters"
  313. EJECT:  Causes a new page to be created.  A regular decimal 12 character (the
  314. female symbol) is also treated as a page eject in the input file as long as it
  315. appears by itself on a line.  See also:  PAGEEJECT, PAGEEJECT=string, and
  316. PAGEFILL.
  317.  
  318. # index "Formatting commands" "EJECT FRONT"
  319. # index "EJECT FRONT"
  320. EJECT FRONT:  Same as EJECT but makes sure you are ejected to the next odd
  321. numbered page.
  322.  
  323. # index "Formatting commands" "EJECT BACK"
  324. # index "EJECT BACK"
  325. EJECT BACK:  Same as EJECT but makes sure you are ejected to the next even
  326. numbered page.
  327.  
  328. # index "Formatting commands" "FLAG"
  329. # index "FLAG"
  330. FLAG=string:  Allows you to set a character or set of characters that appears
  331. at the end of the lines that follow.  The location of the flag characters is
  332. the width of the line plus a space plus whatever string you specify.  For
  333. example, #flag="!" when #width=20 is in effect will result in "!" appearing
  334. at column 22 on each of the effected lines.  Initially defaults to FLAG=NULL.
  335. See also: INDENTER=string.
  336.  
  337. # index "Formatting commands" "FOOTER"
  338. # index "FOOTER"
  339. FOOTER ... END:  Defines a footer to appear at the bottom of each page.  Has
  340. same features that TITLE ... END has; see that discussion.
  341.  
  342. # index "Formatting commands" "-FOOTER"
  343. # index "-FOOTER"
  344. # index "FOOTER" "Deactivating"
  345. -FOOTER:  Turns off the current footer specification.  See FOOTER ... END.
  346.  
  347. # indent 3-3
  348. # index "Formatting commands" "INCLUDE filename"
  349. # index "INCLUDE filename"
  350. # index "Adding files"
  351. INCLUDE filename:  Adds another file to the processing.  This file is processed
  352. according to whatever formatting defaults are in use at that point.
  353.  
  354. # index "Formatting commands" "INDENT=n"
  355. # index "INDENT=n"
  356. INDENT=n:  Indents the text which follows by "n" spaces.  Essentially sets the
  357. left margin.  Default value: INDENT=0.  See also: INDENTER=string.
  358.  
  359. # index "Formatting commands" "INDENT=n-n"
  360. # index "INDENT n-n"
  361. # index "Bulleted text"
  362. INDENT=n-n:  Specifies that most of the lines of a paragraph are to be
  363. indented by "n" spaces whereas the first word of the first line is to be
  364. indented by "n-n" spaces.  For example, "INDENT 5-3" will indent the first word
  365. by two spaces and the subsequent lines by 5 spaces.  This is frequently used for
  366. bulleted text.  See also: INDENTER=string.
  367.  
  368. # indent 3
  369. # index "Bulleted text" "Tricks"
  370. Note with bulleted items that if you want single-spaced items bulleted, include
  371. a #paragraph statement before the next bullet.  This is only a problem because
  372. the routine doesn't start re-indenting text until it thinks it's at another
  373. paragraph.  (A blank line would have worked fine but you want it single spaced
  374. some times.) For example:
  375.  
  376. # unit verbatim
  377.         # indent 5-2
  378.         * This is one paragraph to be indented
  379.         # paragraph
  380.         * And this is another.
  381. # end
  382.  
  383. Remember that the indentation rule applies to the first word of the first line
  384. of a given paragraph.  That word can be a bullet (like an asterisk) but it can
  385. also be an actual word.  This is useful when the first words of different
  386. paragraphs are of different widths.  For example:
  387.  
  388. # unit verbatim
  389.         # indent 8-8
  390.         Home Takes you to the top line
  391.         # indent 8-8
  392.         End Takes you to the bottom line
  393.         # indent 8-8
  394.         F1 Presents help
  395. # end
  396.  
  397. This ends up like this:
  398.  
  399. # unit verbatim
  400.         Home    Takes you to the top line
  401.         End     Takes you to the bottom line
  402.         F1      Presents help
  403. # end
  404.  
  405. # index "Wrapping" "Faking out"
  406. # index "Alt-255 key"
  407. If you want, you can fake the system into thinking that multiple words are, in
  408. fact single words for indentation or word-wrapping purchases.  This is done by
  409. putting a non-printable character instead of a space character between the
  410. words.  A good character to use is Alt-255 (press the Alt key, while it's down,
  411. press the digits 2, 5, 5 on the numeric keypad, then release the Alt key).  This
  412. character shows up as a space but the system treats it as a regular character so
  413. it doesn't split up the words it's between.
  414.  
  415. Warning:  It's easy to forget you used Alt-255.  If you use Alt-255 frequently,
  416. remember to check for it with a hex text viewer (like LIST) when you're
  417. wondering why text didn't wrap or otherwise behave the way you expected.
  418.  
  419. Note that using INDENT=n-n causes pre-indented paragraphs to be treated
  420. differently than any other INDENT specification would.  Consider the following:
  421.  
  422. # unit verbatim
  423.         # -indent
  424.                 This is some
  425.                 sample text
  426.         # indent 3
  427.                 This is some
  428.                 sample text
  429.         # indent 3-3
  430.                 This is some
  431.                 sample text
  432. # end
  433.  
  434. In all cases, the system considers that any line that is either empty or begins
  435. with a space in fact starts a paragraph.  In the first case, the system says
  436. don't change any indentation for either line.  In the second case, the system
  437. figures new paragraphs for each line and additionally indents each line.  In the
  438. last case, the system knows that the first word is be de-indented so it removes
  439. leading spaces.  As a result, you get the following:
  440.  
  441. # unit verbatim
  442.                 This is some
  443.                 sample text
  444.                    This is some
  445.                    sample text
  446.         This is some
  447.         sample text
  448. # end
  449.  
  450. The use of #UNIT and #VERBATIM blocks is one way to insure consistency
  451. within indented sections even for single-line blocks of text.
  452.  
  453. # indent 3-3
  454. # index "Formatting commands" "INDENT=n+n"
  455. # index "INDENT=n+n"
  456. INDENT=n+n:  Specifies that most of the lines of a paragraph are to be
  457. indented by "n" spaces whereas the first line is to be indented by "n+n" spaces.
  458. For example, "INDENT 5+3" will indent the first line by eight spaces and the
  459. subsequent lines by 5 spaces.  See also: INDENTER=string.
  460.  
  461. # index "Formatting commands" "-INDENT"
  462. # index "-INDENT"
  463. -INDENT:  Same thing as INDENT=0.
  464.  
  465. # index "Formatting commands" "INDENTER"
  466. # index "INDENTER=string"
  467. # index "Elsie"
  468. INDENTER=string:  Specifies characters that are to be added to start of each
  469. indented line.  Is sometimes used for highlighting text.  Defaults to
  470. INDENTER=NULL.  See also: FLAG=string and INDENT=n.  For example,
  471.  
  472. # unit verbatim
  473.         # indent 4
  474.         # align width 30
  475.         # indenter="> "
  476.         My cat's name is Elsie.  It actually is "LC" and stands for
  477.         "Lost Cat" but it's "Elsie" for short.  Elsie's actually
  478.         male.  I thought it rude to check.
  479. # end
  480.  
  481. # indent 3
  482. Ends up as:
  483.  
  484. # unit verbatim
  485.         >   My cat's name is Elsie.
  486.         >   It actually is "LC" and
  487.         >   stands for "Lost Cat" but
  488.         >   it's "Elsie" for short.
  489.         >   Elsie's actually male.  I
  490.         >   thought it rude to check.
  491. # end
  492.  
  493. # indent 3-3
  494. # index "Formatting commands" "JUSTIFY"
  495. # index "JUSTIFY"
  496. JUSTIFY:  Justifies text (makes right margins flush) within the default page
  497. width.  See also:  ALIGN, CENTER, RIGHT, VERBATIM, and WIDTH.
  498.  
  499. # index "Formatting commands" "-JUSTIFY"
  500. # index "-JUSTIFY"
  501. -JUSTIFY:  Same thing as VERBATIM.
  502.  
  503. # index "Formatting commands" "MARKER=c"
  504. # index "MARKER=c"
  505. # index "Changing marker character"
  506. MARKER=c:  Defines the single-character marker indicator that will appear in
  507. column 1 of all subsequent lines.  Default value: MARKER=#.
  508.  
  509. # index "Formatting commands" "NEXT=n"
  510. # index "NEXT=n"
  511. NEXT=n:  Specifies which page number will appear the next time ^B appears in
  512. a title, footer, or header.  You can specify "-NEXT" or "NEXT=0" to start
  513. at 0.  Starts at NEXT=1 typically.
  514.  
  515. # index "Formatting commands" "-PAGE"
  516. # index "-PAGE"
  517. -PAGE:  Same as "PAGE=0".
  518.  
  519. # index "Formatting commands" "PAGE=n"
  520. # index "PAGE=n"
  521. PAGE=n:  Defines default page length.  You can say "PAGE=0" to set continuous
  522. pages.  (You have to have a page length specified if you're using the
  523. MULTICOLUMN option though.) Default value:  PAGE=60.
  524.  
  525. # index "Formatting commands" "PAGEEJECT"
  526. # index "PAGEEJECT"
  527. PAGEEJECT:  Says that pages are to be terminated with the standard page eject
  528. sequence (the female symbol--decimal 12--followed by a carriage return and line
  529. feed) instead of padding the pages with blank lines.  This is the default value
  530. and is the same thing as saying "PAGEEJECT=\012\013\010".  See also:
  531. PAGEEJECT=string and PAGEFILL.
  532.  
  533. # index "Formatting commands" "PAGEEJECT=string"
  534. # index "PAGEEJECT=string"
  535. PAGEEJECT=string:  Says that pages are to be terminated with a user-defined
  536. character sequence instead of padding the pages with blank lines.  The main
  537. reason for using this instead of just PAGEEJECT is if you want to remove the
  538. CR/LF that typically follows each page eject.  Another reason is to use
  539. "PAGEEJECT=1\013\010" for files being generated for IBM mainframes that use
  540. carriage control characters.  See also:  PAGEEJECT and PAGEFILL.
  541.  
  542. # index "Formatting commands" "PAGEFILL"
  543. # index "PAGEFILL"
  544. PAGEFILL:  Says that pages are to be ended by padding them with blank lines up
  545. to the specified PAGE=n value.  See also: PAGEEJECT and PAGEEJECT=string.
  546.  
  547. # index "Formatting commands" "PARAGRAPH"
  548. # index "PARAGRAPH"
  549. PARAGRAPH:  Says that a new paragraph is about to begin.  This is primarily used
  550. when you have something like bulleted text which might not be properly aligned.
  551. For example:
  552.  
  553. # unit verbatim
  554.         # align width 40 indent 5-2
  555.         * First bulleted item
  556.         # paragraph
  557.         * Second bulleted item.  Note that this would have been considered
  558.         to be part of the first paragraph since it started in column 1 and
  559.         there was no blank line between them.
  560. # end
  561.  
  562. # index "Formatting commands" "RIGHT"
  563. # index "RIGHT"
  564. RIGHT:  Moves all text to be flush to the right margin.  Doesn't adjust any
  565. spacing between words or anything.  See also:  ALIGN, CENTER, JUSTIFY, VERBATIM,
  566. and WIDTH.
  567.  
  568. # index "Formatting commands" "-RIGHT"
  569. # index "-RIGHT"
  570. -RIGHT:  Same thing as VERBATIM.
  571.  
  572. # index "Formatting commands" "RULE"
  573. # index "RULE string"
  574. RULE=string:  Specifies that a string is to be repeated the width of the line.
  575. This is used to separate sections.  The string can be a single character (like
  576. "RULE=-"), multiple characters (like "RULE="- ""), it can contain decimal and
  577. hexadecimal characters (like "RULE=\066\097\116"), it can be "RULE=NULL" (which
  578. typically results in a blank line), or just simply "RULE" (which is the same
  579. thing as "RULE=-").  Personally, if your printer supports IBM graphics
  580. characters, I find RULE=\196 to be the most pleasing of the rule lines.  (See
  581. BRUCEHEX.DOC file.)
  582.  
  583. # index "Formatting commands" "SINGLE"
  584. # index "SINGLE"
  585. SINGLE:  Single-spaces all text.  This is the default spacing.  See also:
  586. DOUBLE, SPACING=n, and TRIPLE.
  587.  
  588. # index "Formatting commands" "SPACING=n"
  589. # index "SPACING=n"
  590. SPACING=n:  Sets spacing between lines as "n" number of lines.  See also:
  591. DOUBLE (which is SPACING=2), SINGLE (SPACING=1), and TRIPLE (SPACING=3).
  592.  
  593. # index "Formatting commands" "TITLE"
  594. # index "TITLE"
  595. TITLE ...  END:  Defines a title to appear at the top of each page.  Any number
  596. of lines can appear in the title.  The title ends with a marker line that
  597. contains the "end" command; if no "end" command is provided, the program
  598. presumes there is one after the last line of your file.  Spacing, indentation,
  599. width, and alignment cannot vary within the title; the last one assigned will
  600. win.  See "control codes" discussion below for characters that can appear in the
  601. title.  To eliminate the title, define a title without any lines in it.  See
  602. also:  FOOTER ...  END, HEADER ...  END and UNIT ...  END.  Example:
  603.  
  604. # unit verbatim
  605.         # title center width=80
  606.         This is my program!
  607.  
  608.         # end
  609. # end
  610.  
  611. # indent 3
  612. If you plan to change the title within the document, make sure you redefine
  613. it before the new page is generated.  For example:
  614.  
  615. # unit verbatim
  616.         (text)
  617.         # title center width=80
  618.         Index
  619.  
  620.         # end
  621.         #
  622. # end
  623.  
  624. If you define it after the page eject, the new title will not take effect until
  625. a subsequent page (if any) is generated.  By the same token, make sure the title
  626. is defined in the document before any text is filled in if you want the title to
  627. appear on the very first page of the reformatted document.
  628.  
  629. A very useful title is the following:
  630.  
  631. # unit verbatim
  632.         # title center width=80
  633.         ^O%12%                         ^B%3%                       Revised: ^A
  634.  
  635.         # end
  636. # end
  637.  
  638. Consult the control code discussion afterward but this will fill in the output
  639. file's name (taking up 12 spaces so all of your titles look about the same),
  640. the page number (taking up 3 spaces for the page number), and the input file's
  641. date.
  642.  
  643. # indent 3-3
  644. # index "Formatting commands" "-TITLE"
  645. # index "-TITLE"
  646. # index "TITLE" "Deactivating"
  647. -TITLE:  Turns off the current title specification.  See TITLE ... END.
  648.  
  649. # index "Formatting commands" "TRIPLE"
  650. # index "TRIPLE"
  651. TRIPLE:  Triple-spaces all text.  See also: DOUBLE, SINGLE, and SPACING=n.
  652.  
  653. # index "Formatting commands" "UNIT"
  654. # index "UNIT"
  655. UNIT ... END:  Defines a unit of text with its own unique formatting.  Units
  656. can have formatting which differs from the text around it and changing the
  657. formatting within the Unit will not affect the other text.  Has same features
  658. that TITLE ... END has; see that discussion.
  659.  
  660. # indent 3
  661. A typical use for the UNIT command is in combination with VERBATIM.  This is
  662. frequently used when you're aligning or justifying most of the text and then you
  663. have one section that isn't to be changed at all.
  664.  
  665. # indent 3-3
  666. # index "Formatting commands" "VERBATIM"
  667. # index "VERBATIM"
  668. VERBATIM:  Specifies that the text which follows should not be aligned,
  669. justified, etc.  See also: ALIGN, CENTER, JUSTIFY, and RIGHT.
  670.  
  671. # index "Formatting commands" "WIDTH=n"
  672. # index "WIDTH=n"
  673. WIDTH=n:  Specifies the default line width.  (Page lengths are controlled by the
  674. PAGE=command.) Default value:  WIDTH=80.  (Note that LENGTH=n is accepted as a
  675. synonym for WIDTH=n.) See also:  ALIGN, CENTER, JUSTIFY, RIGHT, and VERBATIM.
  676.  
  677. #
  678. # index "Database-related commands"
  679. # indent 0
  680. # rule=-
  681.                            Database-related functions
  682.  
  683. The PAGINATE command provides some features to allow you to use it to read in
  684. and print out ASCII-delimited and dBase files.  For example:
  685.  
  686.         # from ascii
  687.         "Apples",10,5
  688.         "Bananas",20,10
  689.  
  690. will come out as:
  691.  
  692.         Apples   10  5
  693.         Bananas  20 10
  694.  
  695. You can use this capability to embed tables within a report.  You can also
  696. combine this with SORT=varspec, SELECT=varspec, and SUM=varspec specifications
  697. to have the report sorted on specified columns or to subset the columns that get
  698. printed out.  There are some restrictions to all of this and these are described
  699. within each option as appropriate below.
  700.  
  701. NOTE:  In general, combining FROM ASCII or FROM DBF or several of the other
  702. data-base related functions with options like ALIGN and JUSTIFY will not work.
  703. The formatting options will, in general, be ignored.
  704.  
  705. # index "Sorting" "Example"
  706. It's often the case that you will want to deal only with a single data set,
  707. and you'll have no need for actual text.  For example, let's say that you really
  708. want something that will sort a file that contains a lot of data.  No problem:
  709.  
  710.         PAGINATE infile outfile /-PAGE /SORT=1,10
  711.  
  712. # index "dBase files" "Example"
  713. Another example would be that you have something like a dBase file and you want
  714. to print it out.  Again, no problem.  Create a simple control file:
  715.  
  716. # unit
  717. # verbatim
  718.         # heading
  719.         ^H
  720.  
  721.         # end
  722.         # from dbf
  723.         # include sample.dbf
  724. # end
  725.  
  726. and then create your tables with:
  727.  
  728.         PAGINATE ctlfile outfile
  729.  
  730. In general, keep in mind that sorting, totaling, and other special data base
  731. function requests should appear before the data are actually read in.  This
  732. means #SORT or #SUM should appear before the #INCLUDE statement.
  733.  
  734.  
  735. #
  736. # index "Database-related commands" "Default values"
  737. Default initial values (database-related functions):
  738.  
  739.         BAD=ABORT
  740.         -BREAK
  741.         -DELETED
  742.         DELIMS=",,,
  743.         FROM FIXED
  744.         GAP=2
  745.         INMISS=NULL
  746.         INMISSC=NULL
  747.         OUTMISS=NULL
  748.         OUTMISSC=NULL
  749.         SELECT=NULL
  750.         SEPARATOR=" | "
  751.         SORT=NULL
  752.         SUM=NULL
  753.  
  754. # indent 3-3
  755. # index "Database-related commands" "BAD=ABORT"
  756. # index "BAD=ABORT"
  757. BAD=ABORT:  Says that if the program runs into an invalid data value,
  758. it should abort processing entirely.
  759.  
  760. # index "Database-related commands" "BAD=MISSING"
  761. # index "BAD=MISSING"
  762. BAD=MISSING:  Says that if the program runs into an invalid data value, it
  763. should set the value of that variable as "missing" and continue processing.
  764.  
  765. # index "Database-related commands" "BAD=SKIP"
  766. # index "BAD=SKIP"
  767. BAD=SKIP:  Says that if the program runs into an invalid data value, it should
  768. skip the entire data record and continue processing with the next record.
  769.  
  770. # index "Database-related commands" "BREAK"
  771. # index "BREAK"
  772. BREAK=varspec:  BREAK provides a way of generating subtotals or subgroupings
  773. within a listing.  Whenever the value of the variable specified changes, the
  774. program will generate either a blank line or a subtotal (if SUM=varspec has been
  775. specified).  If subtotals are generated, at the end it will generate a grand
  776. total.
  777.  
  778. # index "Database-related commands" "BREAK NULL"
  779. # index "BREAK NULL"
  780. BREAK=NULL:  Turns off all subtotalling.  This is initially the default.
  781.  
  782. # index "Database-related commands" "-BREAK"
  783. # index "-BREAK"
  784. -BREAK:  Same as BREAK=NULL.
  785.  
  786. # index "Database-related commands" "DELETED"
  787. # index "DELETED"
  788. DELETED:  Says to process deleted records as well as non-deleted records from
  789. dBase files.
  790.  
  791. # index "Database-related commands" "-DELETED"
  792. # index "-DELETED"
  793. -DELETED:  Says to skip deleted records.
  794.  
  795. # index "Database-related commands" "DELIMS"
  796. # index "DELIMS"
  797. # index "Hexadecimal codes"
  798. DELIMS=aroundstrings,aroundnums,betweenfields:  Allows you to specify the
  799. delimiters (in sequence) around string fields, around numeric fields, and
  800. between fields.  Defaults to:
  801.  
  802. # unit verbatim
  803.         DELIMS=",,,
  804. # end
  805.  
  806. # indent 3
  807. (Use quotes around character strings, nothing around numeric data, and the third
  808. comma indicates that there is a comma between fields.) The replacement string
  809. can include hexadecimal codes (in the &Hxx format) or decimal codes (in the \ddd
  810. format) if necessary so either of the following would put a tab between fields:
  811.  
  812. # unit verbatim
  813.         DELIMS=",,&H09
  814.         DELIMS=",,\009
  815. # end
  816.  
  817. See the BRUCEHEX.DOC file.
  818.  
  819. # indent 3-3
  820. # index "Database-related commands" "FROM ASCII"
  821. # index "FROM ASCII"
  822. # index "ASCII-delimited files"
  823. # index "Files" "ASCII-delimited"
  824. FROM ASCII:  Specifies that the next non-marker lines contain ASCII-delimited
  825. records.  The ASCII-delimited records can be embedded within the report or
  826. stored as a separate file (brought in with an INCLUDE statement).  See also:
  827. FROM DBF and FROM FIXED and most of the other commands in this section.  See
  828. also:  "Field-definition file" discussion.
  829.  
  830. # index "Database-related commands" "FROM DBF"
  831. # index "FROM DBF"
  832. # index "dBase files"
  833. # index "Files" "dBase"
  834. FROM DBF:  Specifies that the next INCLUDE statement is a dBase file.  Unlike
  835. with FROM FIXED and FROM ASCII, the dBase file has to be external to the control
  836. cards.  The output itself, however, will be included with the regular output
  837. file.  See also: FROM ASCII and FROM FIXED and most of the other commands in
  838. this section.  See also: "Field-definition file" discussion.
  839.  
  840. # index "Database-related commands" "FROM FIXED"
  841. # index "FROM FIXED"
  842. FROM FIXED:  Specifies that the input file is a fixed-field file.  Any document
  843. with regular text (e.g. a letter to your best buddy) is considered fixed-field
  844. by the program; if you classify it as anything else, the program will try to
  845. parse it all.  See also:  FROM ASCII and FROM DBF.
  846.  
  847. # index "Database-related commands" "-GAP"
  848. # index "-GAP"
  849. -GAP:  Same as "GAP=0".
  850.  
  851. # index "Database-related commands" "GAP=n"
  852. # index "GAP=n"
  853. GAP=n:  Specifies the number of spaces to appear between columns when printing
  854. fielded data.  If, for example, two columns of numbers are printed, the GAP
  855. parameter specifies that "n" number of spaces are to appear between these
  856. columns.  You can specify "GAP=0" if you don't want any gap to be inserted.
  857. Defaults to GAP=2.
  858.  
  859. # index "Database-related commands" "HEADER"
  860. # index "HEADER"
  861. # index "Column headers"
  862. HEADER ... END:  Defines a set of column headers that should appear before
  863. the actual data.  Typically, you can bring these in from the actual dBase file
  864. or else use whatever you've specified in the field-definition file by using the
  865. "^H" control code.  Headers are affected by the MULTICOLUMN specification.
  866. Otherwise, they are treated pretty much like Titles and Footers.  See the
  867. discussion of TITLE ... END.
  868.  
  869. # index "Formatting commands" "-HEADER"
  870. # index "-HEADER"
  871. # index "HEADER" "Deactivating"
  872. -HEADER:  Turns off the current header specification.  See HEADER ... END.
  873.  
  874. # index "Database-related commands" "INCLUDE filename"
  875. # index "INCLUDE filename"
  876. # index "Files" "Adding"
  877. INCLUDE filename:  Adds text from another file in at this point.  If the routine
  878. has been told that this is a FROM DBF or FROM ASCII file, it will process the
  879. file appropriately.  The filename specification can include drive and path
  880. information if desired.
  881.  
  882. # index "Database-related commands" "INCLUDE INDEX"
  883. # index "INCLUDE INDEX"
  884. INCLUDE INDEX:  Creates an index listing at this point in the document.  See
  885. also: INDEX.
  886.  
  887. # index "Database-related commands" "INDEF filename"
  888. # index "INDEF filename"
  889. # index "Field-definition file"
  890. INDEF filename:  Specifies that the file characteristics for the input file
  891. which follows are contained in a field-definition file specified as "filename".
  892. The filename spec can include drive and path information if desired.  See the
  893. discussion of "Field-definition files" below.  See also: INDEF NULL.
  894.  
  895. # index "Database-related commands" "INDEF NULL"
  896. # index "INDEF NULL"
  897. INDEF NULL:  Says there is no input file definition for what follows.  Typically
  898. used to turn off the previously-specified input field-definition file.  See
  899. also: INDEF filename.
  900.  
  901. # index "Database-related commands" "-INDEF"
  902. # index "-INDEF"
  903. -INDEF:  Same thing as INDEF NULL.
  904.  
  905. # index "Database-related commands" "INDEX"
  906. # index "INDEX"
  907. # index "See Also references"
  908. INDEX "word" [ "word" ]...  [DUMMY]:  Saves an index record, with the specified
  909. text and the current page number, at this point.  The index is then printed out
  910. when you add an INCLUDE INDEX option.  The multiple word specifications allow
  911. you to specify up to 3 levels of indexing.  For example,
  912.  
  913. # unit verbatim
  914.         # index "Computers" "Maintenance"
  915.         # index "Computers" "Hardware"
  916.         # eject
  917.         # index "Computers" "Hardware"
  918.         # index "Computers" "Software"
  919.         # include index
  920. # end
  921.  
  922. # indent 3
  923. will generate output that looks in part like this:
  924.  
  925. # unit verbatim
  926.         Computers
  927.           Hardware; 1, 2
  928.           Maintenance; 1
  929.           Software; 2
  930. # end
  931.  
  932. # index "MULTICOLUMN" "With INDEX"
  933. # index "INDEX" "With MULTICOLUMN"
  934. You can use MULTICOLUMN in combination with the INDEX command.  Just make sure
  935. you specify the MULTICOLUMN before the INCLUDE INDEX statement as in:
  936.  
  937. # unit verbatim
  938.         # multicolumn 3
  939.         # include index
  940. # end
  941.  
  942. # index "DUMMY index references"
  943. If DUMMY is specified, the page number is not displayed for this item.  This is
  944. typically done when you want the index to provide a cross-reference but you
  945. don't really want any page numbers showing up.  For example:
  946.  
  947. # unit verbatim
  948.         # index "Hardware" "(See Computers)" DUMMY
  949. # end
  950.  
  951. My personal preference is to put all DUMMY index references near the start of
  952. your document so you can find them more easily.
  953.  
  954. # indent 3-3
  955. # index "Database-related commands" "INMISS=val"
  956. # index "INMISS=val"
  957. INMISS=val:  Specifies for ASCII-delimited and dBase input files which numeric
  958. values are to be considered indicators for missing values.  Missing values
  959. are not included in summations.  Defaults to INMISS=NULL.  See also:
  960. INMISSC=val, OUTMISS=val, and OUTMISSC=val.
  961.  
  962. # index "Database-related commands" "INMISSC=val"
  963. # index "INMISSC=val"
  964. INMISSC=val:  Specifies for ASCII-delimited and dBase input files which
  965. character values are to be considered indicators for missing values.  Defaults
  966. to INMISSC=NULL.  See also: INMISS=val, OUTMISS=val, and OUTMISSC=val.
  967.  
  968. # index "Database-related commands" "MULTICOLUMN"
  969. # index "MULTICOLUMN"
  970. # index "SEPARATOR" "With MULTICOLUMN"
  971. MULTICOLUMN=n ...  END:  Specifies that a given block is to be arranged in a
  972. multicolumn format.  The number of columns is specified as "n"; "MULTICOLUMN=2"
  973. would set up a dual-column output.  The SEPARATOR string appears between each of
  974. the columns.  (MULTICOLUMN", by the way, can be abbreviated "MULTI" or
  975. "MULTICOL".)
  976.  
  977. # indent 3
  978. Make sure you put any CENTER or ALIGN or whatever statements after the
  979. MULTICOLUMN statement (VERBATIM will result in lines being truncated).  Any
  980. width specification ("MULTICOLUMN=2 WIDTH=80") is used to determine the total
  981. line width, not the width of each column within the line.  The width of each
  982. column is the total line width (typically 80) divided by the number of columns
  983. minus the width of the separator string.
  984.  
  985. Otherwise, MULTICOLUMN has the same features that TITLE ...  END has; see that
  986. discussion.  (Remember, unless provided otherwise, the "END" command is presumed
  987. to be after the last line of your input file.) See also:  SEPARATOR=string.
  988. Example:
  989.  
  990. # unit verbatim
  991.         # multicolumn 3 separator=" | "
  992.         lines
  993.         lots of lines
  994.         still more
  995.         # end
  996. # end
  997.  
  998. # indent 3-3
  999. # index "Database-related commands" "NULLS"
  1000. # index "NULLS"
  1001. NULLS:  Says that the program will accept values that begin with a decimal
  1002. zero as being a valid value.  Defaults to NULLS.  See also: -NULLS.
  1003.  
  1004. # index "Database-related commands" "-NULLS"
  1005. # index "-NULLS"
  1006. -NULLS:  Says that values which begin with a decimal zero should be treated
  1007. as missing by the program.  Defaults to NULLS.  See also: NULLS.
  1008.  
  1009. # index "Database-related commands" "OUTDEF filename"
  1010. # index "OUTDEF filename"
  1011. # index "Field-definition file"
  1012. OUTDEF filename:  Specifies the field-definition file to create.  Typically, the
  1013. only reason you'd ever use this command is if you want the program to create a
  1014. field-definition file for a dBase input file.  (See the discussion of
  1015. "Field-definition file" later.)  See also:  OUTDEF NULL.
  1016.  
  1017. # index "Database-related commands" "OUTDEF NULL"
  1018. # index "OUTDEF NULL"
  1019. OUTDEF NULL:  Turns off the output field-definition file specification.  See
  1020. also: OUTDEF filename.
  1021.  
  1022. # index "Database-related commands" "-OUTDEF"
  1023. # index "-OUTDEF"
  1024. -OUTDEF:  Same as OUTDEF NULL.
  1025.  
  1026. # index "Database-related commands" "OUTMISS=val"
  1027. # index "OUTMISS=val"
  1028. OUTMISS=val:  Specifies what value will be substituted for missing numeric
  1029. input values on output.  Initially defaults to OUTMISS=NULL.  See also:
  1030. INMISS=val, INMISSC=val, and OUTMISSC=val.
  1031.  
  1032. # index "Database-related commands" "OUTMISSC=val"
  1033. # index "OUTMISSC=val"
  1034. OUTMISSC=val:  Specifies what value will be substituted for missing character
  1035. input values on output.  Initially defaults to OUTMISSC=NULL.  See also:
  1036. INMISS=val, INMISSC=val, and OUTMISS=val.
  1037.  
  1038. # index "Database-related commands" "RESET=string"
  1039. # index "RESET=string"
  1040. RESET=string:  Specifies a character string to stick at the end of the file, to
  1041. reset the printer after the document is printed.  A page eject character (or any
  1042. other user-defined string in the case of PAGEEJECT=string) is typically added
  1043. automatically if /EJECT is specified.  The string can contain special characters
  1044. by using a "\" followed by the three-digit ASCII code for the character.  The
  1045. typical use for this would be to issue a printer reinitialization string.  On a
  1046. Hewlett-Packard printer, this would probably be RESET=\027E.  See also:
  1047. SETUP=string.
  1048.  
  1049. # index "Database-related commands" "SELECT=varspec"
  1050. # index "SELECT=varspec"
  1051. SELECT=varspec:  Specifies which variables or columns should show up in the
  1052. ultimate file.  This allows you to take, for example, a text file and only print
  1053. the middle 10 columns of it or else to take a dBase file and only print certain
  1054. variables.  See the discussion of "Varspecs" later.  See also: SELECT=NULL.
  1055.  
  1056. # index "Database-related commands" "SELECT=NULL"
  1057. # index "SELECT=NULL"
  1058. SELECT=NULL:  Specifies that all variables or columns should show up.  This is
  1059. initially the default.  See also: SELECT=varspec.
  1060.  
  1061. # index "Database-related commands" "-SELECT"
  1062. # index "-SELECT"
  1063. -SELECT:  Same thing as SELECT=NULL.
  1064.  
  1065. # index "Database-related commands" "SEPARATOR"
  1066. # index "SEPARATOR"
  1067. SEPARATOR=string:  Specifies the string to appear between columns in a
  1068. multicolumn output.  The string can contain special characters by using a "\"
  1069. followed by the three-digit ASCII code for the character.  For example, to have
  1070. a graphic vertical bar, use SEPARATOR=\032\179\032 or else enter it directly as
  1071. SEPARATOR=" │ ".  Initially defaults to SEPARATOR=" | ".  (In case that reflows
  1072. when you reformat this documentation, that's quote, space, vertical bar, space,
  1073. quote).  See also:  MULTICOLUMN=n.
  1074.  
  1075. # index "Database-related commands" "SETUP=string"
  1076. # index "SETUP=string"
  1077. SETUP=string:  Specifies the character string to strick at the beginning of the
  1078. file, to initialize the printer before the document is printed.  Typically, you
  1079. might use an initialization string that sets the printer in compressed,
  1080. landscape, or whatever mode.  The string can contain special characters by using
  1081. a "\" followed by the three-digit ASCII code for the character.  On a
  1082. Hewlett-Packard printer, this would typically be one of the following codes:
  1083.  
  1084. # unit verbatim
  1085.         SETUP=\027E             (portrait mode, 80 column)
  1086.         SETUP=\027E\027(s16.66H (portrait mode, 132 column)
  1087. # end
  1088.  
  1089. # indent 3
  1090. On an Epson MX dot-matrix printer, you would typically use these codes:
  1091.  
  1092. # unit verbatim
  1093.         SETUP=\015              (portrait mode, 80 column)
  1094.         SETUP=\018              (portrait mode, 132 column)
  1095. # end
  1096.  
  1097. See also: RESET=string.
  1098.  
  1099. # indent 3-3
  1100. # index "Database-related commands" "SORT=varspec"
  1101. # index "SORT=varspec"
  1102. SORT=varspec:  Specifies that the lines which follow should be sorted according
  1103. to a particular group of columns or variables.  See the discussion of "Varspecs"
  1104. later.  Sorting is done based on a case-sensitive search ("Apple" and "Banana"
  1105. will appear before "air").  Note that sorting works well for character strings
  1106. but negative numbers can cause it all sorts of problems.  The sort field
  1107. specification is limited to 50 characters.  Note that you cannot combine sorting
  1108. specifications (e.g.  descending for some columns and ascending for others.)
  1109. Initially defaults to SORT=NULL.  See also:  SORT=NULL.  Basic sorting
  1110. specifications available here (see each separately):
  1111.  
  1112. # unit verbatim
  1113.         SORT      --> case-sensitive, ascending sort
  1114.         SORTD     --> case-sensitive, descending sort
  1115.         SORTI     --> case-insensitive, ascending sort
  1116.         SORTDI    --> case-insensitive, descending sort
  1117.         SORTID    --> case-insensitive, descending sort
  1118. # end
  1119.  
  1120. # index "Database-related commands" "SORT=NULL"
  1121. # index "SORT=NULL"
  1122. SORT=NULL:  Turns off any sorting specification.  This statement is vital if you
  1123. have any text appearing after a sorted section.  Remember, you cannot have
  1124. multiple sorting specifications going on so this is the same as all of the
  1125. following:  -SORT, -SORTI, -SORTD, -SORTID, -SORTDI, SORTI=NULL, SORTD=NULL,
  1126. SORTDI=NULL, and SORTID=NULL.  This statement is initially the default.
  1127.  
  1128. # index "Database-related commands" "-SORT"
  1129. # index "-SORT"
  1130. -SORT:  Same as SORT=NULL.
  1131.  
  1132. # index "Database-related commands" "SORTD=varspec"
  1133. # index "SORTD=varspec"
  1134. SORTD=varspec:  Similar to SORT=varspec but sorting is done in descending
  1135. sequence.  See SORT=varspec and SORT=NULL.
  1136.  
  1137. # index "Database-related commands" "SORTD=NULL"
  1138. # index "SORTD=NULL"
  1139. SORTD=NULL:  Same as SORT=NULL.
  1140.  
  1141. # index "Database-related commands" "-SORTD"
  1142. # index "-SORTD"
  1143. -SORTD:  Same as SORT=NULL.
  1144.  
  1145. # index "Database-related commands" "SORTDI=varspec"
  1146. # index "SORTDI=varspec"
  1147. SORTDI=varspec:  Similar to SORT=varspec but sorting is done in descending
  1148. sequence and sorting is case insensitive.  Identical to SORTID=varspec.  See
  1149. SORT=varspec and SORT=NULL.
  1150.  
  1151. # index "Database-related commands" "SORTDI=NULL"
  1152. # index "SORTDI=NULL"
  1153. SORTDI=NULL:  Same as SORT=NULL.
  1154.  
  1155. # index "Database-related commands" "-SORTDI"
  1156. # index "-SORTDI"
  1157. -SORTDI:  Same as SORT=NULL.
  1158.  
  1159. # index "Database-related commands" "SORTI=varspec"
  1160. # index "SORTI=varspec"
  1161. SORTI=varspec:  Same as SORT=varspec except the sorting is done in a
  1162. case-insensitive manner ("big" shows up between "Apple" and "Caramel").  See
  1163. SORT=varspec and SORT=NULL.
  1164.  
  1165. # index "Database-related commands" "SORTI=NULL"
  1166. # index "SORTI=NULL"
  1167. SORTI=NULL:  Same as SORT=NULL.
  1168.  
  1169. # index "Database-related commands" "-SORTI"
  1170. # index "-SORTI"
  1171. -SORTI:  Same as SORT=NULL.
  1172.  
  1173. # index "Database-related commands" "SORTID=varspec"
  1174. # index "SORTID=varspec"
  1175. SORTID=varspec:  Same as SORTDI=varspec.
  1176.  
  1177. # index "Database-related commands" "SORTID=NULL"
  1178. # index "SORTID=NULL"
  1179. SORTID=NULL:  Same as SORT=NULL.
  1180.  
  1181. # index "Database-related commands" "-SORTID"
  1182. # index "-SORTID"
  1183. -SORTID:  Same as SORT=NULL.
  1184.  
  1185. # index "Database-related commands" "SUM"
  1186. # index "Adding Columns Of Numbers" "(See SUM)" DUMMY
  1187. # index "SUM"
  1188. SUM=varspec:  Summarizes a group of numbers and presents the total after the
  1189. items are displayed.  Initially defaults to SUM=NULL.  See also:  SUM=NULL.
  1190.  
  1191. # indent 3
  1192. An example of summing might be like the following:
  1193.  
  1194. # unit verbatim
  1195.   # from fixed
  1196.   # sort=28-34
  1197.   # sum=28-34,43-49,57-62,73-78
  1198.    370 DISK STORAGE           $75.14         $35.58       $23.28          $49.16
  1199.    370 DISK STORAGE           $12.80          $6.26        $6.24          $12.76
  1200.    370 DISK STORAGE            $0.00          $0.00        $0.00           $0.00
  1201.    370 DISK STORAGE            $0.00          $0.00       $11.38          $22.76
  1202.    370 DISK STORAGE           $61.56         $29.64       $11.40          $23.68
  1203.    370 DISK STORAGE            $0.00          $0.00        $0.00           $0.00
  1204.    370 DISK STORAGE            $0.72          $0.13        $0.13           $0.72
  1205.    370 DISK STORAGE            $1.99          $0.13        $1.64          $16.40
  1206.    370 DISK STORAGE            $0.00          $0.00        $0.00           $0.00
  1207.    370 DISK STORAGE            $0.27          $0.13        $0.13           $0.27
  1208.    370 DISK STORAGE            $0.00          $0.00        $0.00           $0.00
  1209.    370 DISK STORAGE          $195.48         $94.12       $39.28          $81.58
  1210.    370 DISK STORAGE            $0.00          $0.00        $0.00           $0.00
  1211.    370 DISK STORAGE          $130.01         $90.84       $24.99          $35.77
  1212.    370 DISK STORAGE            $8.10          $3.90        $2.62           $5.44
  1213.   # -sum
  1214. # end
  1215.  
  1216. This will sort the 15 lines and summarize the four columns of numbers.
  1217.  
  1218. # indent 3-3
  1219. # index "Database-related commands" "SUM=NULL"
  1220. # index "SUM=NULL"
  1221. SUM=NULL:  Turns off summarization.
  1222.  
  1223. # index "Database-related commands" "-SUM"
  1224. # index "-SUM"
  1225. -SUM:  Same as SUM=NULL.
  1226.  
  1227. #
  1228. # indent 0
  1229. # index "Control codes"
  1230. # index "Page numbers"
  1231. # index "Date-stamps"
  1232. # index "Time-stamps"
  1233. # index "Column headers"
  1234. # index "Titles"
  1235. # index "^B"
  1236. # index "^D"
  1237. # index "^T"
  1238. # index "^N"
  1239. # index "^A"
  1240. # index "^I"
  1241. # index "^H"
  1242. # index "^O"
  1243. # index "%n%"
  1244. Control codes:
  1245.  
  1246. Within titles, headers, and footers, you can embed the following codes.  These
  1247. codes are case-sensitive; "^b^" will not translated as the current page number.
  1248. These codes will be expanded on output:
  1249.  
  1250.         ^B      current page number
  1251.         ^D      pagination date (in mm/dd/yy format)
  1252.         ^T      pagination time (in hh:mm format)
  1253.         ^N      name of the input file (without drive or path information)
  1254.         ^A      input file's creation date (in mm/dd/yy format)
  1255.         ^I      input file's creation time (in hh:mm format)
  1256.         ^H      column headers (when appropriate)
  1257.         ^O      output file's name (without drive or path information)
  1258.  
  1259. You can also immediately follow any of the control codes with a field width by
  1260. including one or two digits within two percentage signs.  For example, "^O%12%"
  1261. will force the output file's name to be 12 characters in length.  This is useful
  1262. for making sure that the headers are all a uniform length, something which would
  1263. otherwise be complicated because the length of the page number can vary.
  1264.  
  1265. Without using the length codes, formatting commands like centering will be
  1266. adjusted based on the replacement contents for these codes.  A line containing a
  1267. one-digit page number will be centered differently than the exact same line
  1268. containing a three-digit page number.
  1269.  
  1270. Example:
  1271.  
  1272.         # title center width 80
  1273.         File ^N listing, page ^B
  1274.  
  1275.         # end
  1276.  
  1277. or
  1278.  
  1279.         # title center width 80
  1280.         ^O%12%                         ^B%3%                       Revised: ^A
  1281.  
  1282.         # end
  1283.  
  1284. #
  1285. # index "Varspecs"
  1286. # index "Specifying columns"
  1287. # index "Specifying variables"
  1288. # index "Columns" "Specifying"
  1289. Varspecs:
  1290.  
  1291. Several of the commands (e.g.  SELECT and SORT) expect you to pass in a
  1292. "varspec" parameter.  Varspec's indicate which variables or columns to process.
  1293.  
  1294. The format for the varspec is:
  1295.  
  1296.         n[-n] [ , n-[n] ]...
  1297.  
  1298. where "n" is a single variable/column.  "n-n" indicates you want a range of
  1299. variables/columns.
  1300.  
  1301. For FROM ASCII or FROM DBF, the "n" corresponds to a variable number.  For FROM
  1302. FIXED, the "n" corresponds to a physical one-byte column.  For example:
  1303.  
  1304.         # from ascii
  1305.         # select 1,3
  1306.         "Testing",2,4
  1307.         "All",5,7
  1308.         "This",1,6
  1309.  
  1310. says to display the 1st and 3rd variables and results in something like this:
  1311.  
  1312.         Testing  4
  1313.         All      7
  1314.         This     6
  1315.  
  1316. On the other hand, if you're processing fixed-fielded data, the varspec will
  1317. select individual columns.  So:
  1318.  
  1319.         # from fixed
  1320.         # select 1-10,15
  1321.         1234567_10_2345678
  1322.         Testing   abcdefgh
  1323.         All       abcdefgh
  1324.         This      abcdefgh
  1325.  
  1326. will come out like this:
  1327.  
  1328.         Testing   e
  1329.         All       e
  1330.         This      e
  1331.  
  1332. #
  1333. # index "Field-definition file"
  1334. # index "ASCII-delimited files"
  1335. # index "dBase files"
  1336. Field-definition file:
  1337.  
  1338. For data files (ASCII-delimited, dBase, and fixed field input files), you can
  1339. use PAGINATE.EXE to present a reasonably formatted listing of variables.  Unless
  1340. you are reading a dBase file, this program requires a field-definition file to
  1341. figure out the characteristics for each field and also to set certain file
  1342. characteristics.  If you're processing an ASCII-delimited input file, the
  1343. routine can try to create a field-definition file for you if desired.
  1344.  
  1345. The definition file can be created with any text editor.  The definition file
  1346. consists of several records with the following fields separated by spaces.
  1347. Except for the record type indicator (which must begin in column 1), all other
  1348. fields can be placed in any columns:
  1349.  
  1350.         (1) record type (see below)
  1351.         (2) length of field on input
  1352.         (3) number of decimal places for numeric data (if you don't know,
  1353.             put a "?" here; for non-numeric data, a "0" is fine) on output
  1354.         (4) length of field on output
  1355.  
  1356. Any characters after the field length are treated as comment fields.  You would
  1357. typically use this to enter the field name or column position or any other
  1358. information of use to you.
  1359.  
  1360. The data record types accepted by this routine are as follows:
  1361.  
  1362.         type C = character data
  1363.              N = numeric
  1364.              L = logical (T or F)
  1365.              D = date (in yyyymmdd format)
  1366.  
  1367. The data fields should be in the order the fields are found in the source file.
  1368.  
  1369. Note that for fixed field files, you have to account for every byte in the file.
  1370. If you have something like this:
  1371.  
  1372.         12345678_1_2345678_2_2345678_3      (column positions)
  1373.         APPLE    X Y    12 BANANAS
  1374.  
  1375. Even though you may think you only have five fields, the following .DEF file
  1376. will NOT work:
  1377.  
  1378.         ; Bad .DEF file:  Note does not account for blank spaces
  1379.         C   8 0   8 Fruit1
  1380.         C   1 0   1 Class1
  1381.         C   1 0   1 Class2
  1382.         N   5 0   5 Value
  1383.         C  11 0  11 Fruit2
  1384.  
  1385. #
  1386. You may want the Fruit1 field to be in columns 1 through 8 and Class1 to be in
  1387. column 10 but the routine will not know to skip column 9 so it will start
  1388. reading Class1 beginning in column 9, Class2 beginning in column 10, etc.  To
  1389. drop the blank positions, you have to add dummy fields on input and ask for them
  1390. to be dropped on output:
  1391.  
  1392.         ; Good .DEF file:  Spaces between fields are accounted for
  1393.         C   8 0   8 Fruit1
  1394.         C   1 0   0 Filler
  1395.         C   1 0   1 Class1
  1396.         C   1 0   0 Filler
  1397.         C   1 0   1 Class2
  1398.         C   1 0   0 Filler
  1399.         N   5 0   5 Value
  1400.         C   1 0   0 Filler
  1401.         C  11 0  11 Fruit2
  1402.  
  1403. You can also use the input field length and output field lengths to either drop
  1404. fields using other formats (by specifying a zero length for the output field
  1405. length) or for creating fields on output (by specifying a zero length for the
  1406. input field length).  You can also use this to expand on contract a field.  For
  1407. example, if Fruit1 is 8 characters long but you only want it to occupy 4
  1408. characters on output (thus the field would be truncated), specify 8 for the
  1409. input field length and 4 for the output field length.
  1410.  
  1411. If the output field length is wider than the input field length, the data values
  1412. will be shifted right or left depending on the data type.  In general, numeric
  1413. fields are shifted right (so extra spaces show up in front of the number) and
  1414. all other field types (character, logical, or date) are shifted left.
  1415.  
  1416.  
  1417. #
  1418. # index "Parameters" "Specifying"
  1419. # index "INI file"
  1420. # index "SET PAGINATE environmental variable"
  1421. # index "Marker commands" "From the command line"
  1422. Specifying parameters:
  1423.  
  1424. Parameters for this program can be set in the following ways.  The last setting
  1425. encountered always wins:
  1426.   - Read from an *.INI file (see BRUCEINI.DOC file),
  1427.   - Through the use of an environmental variable (SET PAGINATE=whatever), or
  1428.   - From the command line (see "Syntax" below)
  1429.  
  1430. In most cases, the marker commands themselves can be passed in at the command
  1431. line or through one of the other methods specified above.  The only difference
  1432. is that the marker commands then begin with "/" instead of (by default) "#".
  1433. Some marker commands (like TITLE ... END) don't make sense in the command line.
  1434.  
  1435.  
  1436. # index "Character-translation file"
  1437. # index "/Linitfile parameter"
  1438. # index "Graphics characters" "Removing"
  1439. # index "Non-printable characters" "Removing"
  1440. # index "Characters" "Removing"
  1441. # index "(NONE) replacement"
  1442. # index "/Iinitfile parameter"
  1443. Character-translation file:
  1444.  
  1445. PAGINATE will process a character-translation (lookup) table if one is found.
  1446. This table can be in your standard *.INI file (e.g.  PAGINATE.INI) if desired or
  1447. it can be a separate file specified using the /Linitfile parameter.
  1448.  
  1449. This table allows you to replace all instances of one character in your input
  1450. file with another when you write the file out.
  1451.  
  1452. What would you use this for?  Your document might contain characters like
  1453. graphic characters.  You might have problems if you wanted to e-mail this
  1454. document to someone or print it on a printer than didn't recognize the
  1455. characters.
  1456.  
  1457. #
  1458. For example, something like:
  1459.  
  1460. # unit verbatim
  1461.          ┌─┬─┐   ╔═╦═╗
  1462.          │ │ │   ║ ║ ║
  1463.          ├─┼─┤   ╠═╬═╣
  1464.          │ │ │   ║ ║ ║
  1465.          └─┴─┘   ╚═╩═╝
  1466. # end
  1467.  
  1468. looks great on the screen but it might print out horribly.
  1469.  
  1470. If you want, you can tell PAGINATE to do a one-for-one character replacement on
  1471. any characters.  This is done through the character-translation file.  This
  1472. file, which can be embedded in the standard PAGINATE.INI file, consists of a
  1473. series of lines in the following format:
  1474.  
  1475.         inchar = outchar
  1476.  
  1477. where "inchar" is the character to change from and "outchar" is what to change
  1478. the character to.  Both portions can consist of regular non-space ASCII text
  1479. characters (like "A" or "z") as well as hexadecimal values (in the form &Hxx) or
  1480. decimal values (in the form \nnn).  (See the BRUCEHEX.DOC file.) To remove a
  1481. character entirely, assign it the value of (NONE).  You cannot use a space or
  1482. equal sign in either "inchar" or "outchar"; use the hexadecimal or decimal
  1483. representations instead.  The table does not have to be in any specified order.
  1484. Lines can end with "/*" followed by a comment if you want.  Examples:
  1485.  
  1486.         \186 = |     /* ║ becomes |
  1487.         \205 = -     /* ═ becomes -
  1488.         \206 = +     /* ╬ becomes +
  1489.         \027 = (NONE)  /* Remove excape characters entirely
  1490.  
  1491. Since lines beginning with "/" are treated as command-line defaults, you must
  1492. use \047 or &H2F if you want to override the definition of "/".
  1493.  
  1494. NOTE:  If a character-translation file is specified, all instances of Alt-0
  1495. will be removed from the resulting file.  (This is how the program
  1496. handles replacements with (NONE)).  Redefine \000 as \032 or something if you
  1497. want to keep them.
  1498.  
  1499. # index "Alt-255 key" "Removing"
  1500. Note that Alt-255 is automatically translated to Alt-32 (regular space)
  1501. even if character-translation table is used.  Alt-255 is used internally by
  1502. the program to handle things like bullets and such.  It is also the recommended
  1503. character to use to avoid certain combinations of words from wrapping.
  1504.  
  1505. Blank lines or those beginning with the following are ignored as comments:
  1506.  
  1507.         ;    (semi-colon)
  1508.         :    (colon)
  1509.         '    (quote)
  1510.  
  1511. # index "PAGNOASC.INI"
  1512. The lookup tables can also be read from a different table specified by the
  1513. /Linitfile parameter.  Use the enclosed PAGNOASC.INI as your lookup file if you
  1514. want to remove all non-standard characters from your file.  Modify as necessary.
  1515.  
  1516.  
  1517. #
  1518. # index "Examples"
  1519. # index "Directories" "Multicolumn"
  1520. # index "Formatting commands" "MARKER=c" "Example"
  1521. # index "MARKER=c" "Example"
  1522. Examples:
  1523.  
  1524. This section adds some examples of how you can use PAGINATE.  I'll add to it
  1525. over time.
  1526.  
  1527. Multicolumn Directories:  You want to generate a multicolumn listing of
  1528. directories which are sorted going down the page instead of across the page
  1529. like "DIR /W" does.  PAGINATE can handle this fairly easily.
  1530.  
  1531. Create a control file called C:\DIRW.CTL with these statements (the SETUP and
  1532. RESET statements work for Hewlett-Packard printers to put you into compressed
  1533. mode):
  1534.  
  1535.         #WIDTH 132
  1536.         #SETUP "\027E"
  1537.         #RESET "\027E\027(s16.66H"
  1538.         #MULTICOLUMN 7
  1539.         #MARKER=*
  1540.  
  1541. If you don't want it to be in a compressed mode, use the following control file:
  1542.  
  1543.         #WIDTH 80
  1544.         #MULTICOLUMN 5
  1545.         #MARKER=*
  1546.  
  1547. (The #MARKER=* is in there because a number of shareware companies have
  1548. gotten into using weird characters as the first letter of the file name to
  1549. make sure the file sorts higher in an alphabetical list.  Several programs
  1550. may begin with a pound sign but none can begin with an asterisk.)  Then create a
  1551. batch file called DIRW.BAT:
  1552.  
  1553.         DIR /ON > TEMP.TXT
  1554.         PAGINATE TEMP.TXT TEMP.OUT /CC:\DIRW.CTL /OVERWRITE
  1555.         DEL TEMP.TXT
  1556.  
  1557. This will route your directory to a disk file and rewrite it as TEMP.OUT in a
  1558. multicolumn format with printer controls.
  1559.  
  1560.  
  1561. # index "Windows" "Long-line files"
  1562. # index "Lines" "Wrapping long ones"
  1563. # index "Notepad" "Converting from"
  1564. Those long-line things you get from writing out the file from Windows:  You've
  1565. done this.  You ask for a text file.  They've created it using the Windows
  1566. notepad.  You look at it and the lines scroll endlessly--one line per paragraph.
  1567. How are you supposed to print that?!
  1568.  
  1569. Simple.  Let's say the file name is NOTEPAD.TXT.  Just issue the following
  1570. command:
  1571.  
  1572.         PAGINATE NOTEPAD.TXT /ALIGN /WIDTH=80
  1573.  
  1574.  
  1575. #
  1576. # index "Syntax"
  1577. Syntax:
  1578.  
  1579. # unit
  1580. # verbatim
  1581.     PAGINATE { filespec | @listfile } [ outfile ] [ /Cctlfile ] [ /DEBUG ]
  1582.       [ /OVERWRITE | /APPEND | /-OVERWRITE | /OVERASK ]
  1583.       [ /marker command ]...
  1584.       [ /EXT=.xxx ] [ /PAUSE | /-PAUSE ] [ /BEEP | /-BEEP ]
  1585.       [ /Iinitfile | /-I ] [ /Linitfile ] [ /? ] [ /?&H ]
  1586. # end
  1587.  
  1588. where:
  1589.  
  1590. # index "Filespec parameter"
  1591. # index "Files" "Input"
  1592. "filespec" tells the routine which file or files are to be processed.  It can
  1593. include path information if desired.  It can also include standard DOS wildcards
  1594. as long as an output file is not specified.  The input files can contain INCLUDE
  1595. statements to add in other files to process.
  1596.  
  1597. # index "@listfile parameter"
  1598. # index "Files" "Input"
  1599. "@listfile" allows you to have a variety of file specifications saved in a text
  1600. file named "listfile".  Each line in the file should consist of one file
  1601. specification, each of which can include a path and wildcards if desired.  Blank
  1602. lines and lines beginning with semi-colons, colons, or quotes are ignored.
  1603.  
  1604. # index "Outfile parameter"
  1605. "outfile" specifies the name of the output file that is to contain the resulting
  1606. text.  By default, the output file name will be the name of the input file with
  1607. a .PAG extension.  (The default .PAG extension can be overridden using the
  1608. "/EXT=.xxx" parameter.)
  1609.  
  1610. # index "Ctlfile parameter"
  1611. # index "/Cctlfile parameter"
  1612. "/Cctlfile" is basically the same thing as the infile but it typically contains
  1613. only marker commands.  For example, you might have a straight text file
  1614. contained in "infile" and then use the "ctlfile" to say how that text file
  1615. should be processed.
  1616.  
  1617. # index "/DEBUG parameter"
  1618. "/DEBUG" is used for debugging purposes.  You might use it when you get an
  1619. error message that doesn't clearly tell you where the error occurred.  /DEBUG
  1620. will show you the text as it's processed and let you see what's actually being
  1621. processed and written.
  1622.  
  1623. # index "/OVERWRITE parameter"
  1624. "/OVERWRITE" says to overwrite the output file if it exists already.
  1625.  
  1626. # index "/-OVERWRITE parameter"
  1627. "/-OVERWRITE" says to abort if the output file exists already.
  1628.  
  1629. # index "/APPEND parameter"
  1630. "/APPEND" says to append (add) to the output file if it exists already.  This
  1631. option is only available if you're creating either a fixed-field or ASCII-
  1632. delimited output file.
  1633.  
  1634. # index "/OVERASK parameter"
  1635. "/OVERASK" says to ask if the output file exists already.  This is initially
  1636. the default.
  1637.  
  1638. "/marker command" allows you to specify one or more marker commands.  These are
  1639. spelled out in this documentation.  Note that all marker commands can instead
  1640. be embedded in either the control file or the document itself.
  1641.  
  1642. # index "/EXT=.xxx parameter"
  1643. "/EXT=.xxx" allows you to specify a different default file extension for the
  1644. output file.  This parameter only matters if you do not explicitly specify an
  1645. output file name.  The default value is "/EXT=.PAG".
  1646.  
  1647. #
  1648. # index "/PAUSE parameter"
  1649. "/PAUSE" waits for you to press ENTER if there is a compilation error and then
  1650. returns you to DOS.  This is useful if you're using PAGINATE to process a whole
  1651. series of files.  The default value is "/-PAUSE".
  1652.  
  1653. # index "/-PAUSE parameter"
  1654. "/-PAUSE" says to return to DOS without prompting you if there is a compilation
  1655. error.  This is initially the default.
  1656.  
  1657. # index "/BEEP parameter"
  1658. "/BEEP" says to sound a tone when the program is finished executing.
  1659.  
  1660. # index "/-BEEP parameter"
  1661. "/-BEEP" says to not sound a tone when the program finishes.  This is initially
  1662. the default.
  1663.  
  1664. # index "/Iinitfile parameter"
  1665. "/Iinitfile" says to read an initialization file with the file name "initfile".
  1666. The file specification *must* contain a period.  Initfiles are described in the
  1667. BRUCEINI.DOC file.  Initially defaults to "/IPAGINATE.INI".
  1668.  
  1669. # index "/-I parameter"
  1670. # index "/INULL parameter"
  1671. "/-I" (or "/INULL") says to skip loading the initialization file.
  1672.  
  1673. # index "/Linitfile parameter"
  1674. "/Linitfile" says that the "Character-translation table" codes are found in a
  1675. file other than from the default "/Iinitfile" file.  This is primarily useful if
  1676. you want to have a master *.INI file and a separate code lookup table.
  1677. PAGNOASC.INI is provided as one sample character-translation table.  It removes
  1678. all graphics and other possibly non-printable characters from the output file.
  1679.  
  1680. # index "/? parameter"
  1681. "/?" or "/HELP" or "HELP" shows you the syntax for the command.
  1682.  
  1683. # index "/?&H parameter"
  1684. "/?&H" gives you a hexadecimal and decimal conversion table.
  1685.  
  1686.  
  1687. #
  1688. # index "Return codes"
  1689. # index "ERRORLEVEL codes"
  1690. Return codes:
  1691.  
  1692. PAGINATE returns the following ERRORLEVEL codes:
  1693.  
  1694.         0 = no problems
  1695.       254 = errors encountered in processing input files
  1696.       255 = syntax problems or /? requested
  1697.  
  1698.  
  1699. # index "Guthrie, Bruce"
  1700. # index "Wayne Software"
  1701. # index "bguthrie@nmaa.org"
  1702. # index "e-mail contact"
  1703. # index "Author"
  1704. Author:
  1705.  
  1706. This program was written by Bruce Guthrie of Wayne Software.  It is free for use
  1707. and redistribution provided relevant documentation is kept with the program, no
  1708. changes are made to the program or documentation, and it is not bundled with
  1709. commercial programs or charged for separately.  People who need to bundle it in
  1710. for-sale packages must pay a $50 registration fee to "Wayne Software" at the
  1711. following address.
  1712.  
  1713. Additional information about this and other Wayne Software programs can be found
  1714. in the file BRUCEymm.DOC which should be included in the original ZIP file.
  1715. ("ymm" is replaced by the last digit of the year and the two digit month of the
  1716. release.  BRUCE512.DOC came out in December 1995.  This same naming convention
  1717. is used in naming the ZIP file that this program was included in.) Comments and
  1718. suggestions can also be sent to:
  1719.  
  1720.  
  1721.                 Bruce Guthrie
  1722.                 Wayne Software
  1723.                 113 Sheffield St.
  1724.                 Silver Spring, MD 20910
  1725.  
  1726.                 fax: (301) 588-8986
  1727.                 e-mail: bguthrie@nmaa.org
  1728.                 http://hjs.geol.uib.no/guthrie/
  1729.  
  1730. See BRUCEymm.DOC file for additional contact information.
  1731.  
  1732. Foreign users:  Please provide an Internet e-mail address in all correspondence.
  1733.  
  1734. # title center width=80
  1735. PAGINATE Index                       ^B%3%                       Revised: ^A
  1736.  
  1737. # end
  1738. #
  1739. # multicolumn 2
  1740. # include index
  1741. # end
  1742.